Versioning the retail react app #1209

vmarta · 2023-05-16T16:23:07Z

To get us ready to version the retail-react-app (or any other package in the monorepo) with its own independent version, this PR implements all of the scripts necessary to support the new release process.

Related spike PR #1167

Remaining tasks:

Fix bugs with the publishing script ← for more details, see the todos added in the code
Undo the changes made to the generator files

How to Test-Drive This PR

I've been testing the PR by going through the following scenarios: releasing the SDK, commerce-sdk-react, and then the retail-react-app. To thoroughly test them, please run a local npm registry first:

cd packages/pwa-kit-create-app
node scripts/run-local-npm.js

Releasing SDK v3.0.0

cd <monorepo root>
npm run bump-version -- 3.0.0-preview.0
Verify that all of the packages are bumped, but independent packages like the retail-react-app would still be at their dev version but incremented (2.8.0-dev.0 → 2.8.0-dev.1)
npm run bump-version -- 3.0.0

Switching to the publishing step. Now imagine that we have pushed our changes to GitHub and CI would take care of the publishing to npm.

Open up the file publish-to-npm.js and edit the branchName to release-3.0.x.
Commit all the changes to have a clean working tree
npm run publish-to-npm
all public packages should be published.

Switching to the clean-up steps:

npm run bump-version -- 3.1.0-dev to prepare for the next minor release.
Commit all the changes again, so you can test the next scenario from a clean slate.

Releasing commerce-sdk-react v1.0.0

cd <monorepo root>
npm run bump-version:commerce-sdk-react -- 1.0.0-preview.0
The SDK dependencies should be downgraded to 3.0.0
npm run bump-version:commerce-sdk-react -- 1.0.0

Switching to the publishing step. Now imagine that we have pushed our changes to GitHub and CI would take care of the publishing to npm.

Open up the file publish-to-npm.js and edit the branchName to release-commerce-sdk-react-1.0.x.
Commit all the changes to have a clean working tree
npm run publish-to-npm
Only the commerce-sdk-react package is published.

Switching to the clean-up steps:

npm run bump-version:commerce-sdk-react -- 1.1.0-dev to prepare for the next minor release.
The above step would restore the dev version of the SDK dependencies
Commit all the changes again, so you can test the next scenario from a clean slate.

Releasing retail-react-app v1.0.0

These steps are pretty much the same as releasing the previous commerce-sdk-react.

cd <monorepo root>
npm run bump-version:retail-react-app -- 1.0.0-preview.0
The SDK dependencies should be downgraded to 3.0.0
npm run bump-version:retail-react-app -- 1.0.0

Switching to the publishing step. Now imagine that we have pushed our changes to GitHub and CI would take care of the publishing to npm.

Open up the file publish-to-npm.js and edit the branchName to release-retail-react-app-1.0.x.
Commit all the changes to have a clean working tree
npm run publish-to-npm
Only the retail-react-app package is published.

Switching to the clean-up steps:

npm run bump-version:retail-react-app -- 1.1.0-dev to prepare for the next minor release.
The above step would restore the dev version of the SDK dependencies

Checklists

General

Changes are covered by test cases
CHANGELOG.md updated with a short description of changes (not required for documentation updates)

Accessibility Compliance

You must check off all items in one of the follow two lists:

There are no changes to UI

or...

Changes were tested with a Screen Reader (iOS VoiceOver or Android Talkback) and had no issues
Changes comply with WCAG 2.0 guidelines levels A and AA
Changes to common UI patterns and interactions comply with WAI-ARIA best practices

Localization

Changes include a UI text update in the Retail React App (which requires translation)

* resolve package lock errors * clean console logs and code * more cleanup, remove duplicate items in overrideregex * upgrade minimatch version, match all file extensions, match with no file extension

…e/template-extensibility * feature/template-extensibility-stress-test: fix some problems with final cleanup Remove all console logs / cleanup / unnecessary code fix dependency dupes add missing pwa-kit packages more fixes for out of sync package / lockfiles Add back missing `scripts` in package.json after bad merge Add missing template files fix bad upstream merge changes add the whole `template-retail-react-app` under `app` dir to stress test performance with high number of file overrides Fix `pwa-kit-dev` paths that didn't know about `overrides` in build pipeline # Conflicts: # packages/_stress-test-project/build/loadable-stats.json # packages/commerce-sdk-react/package-lock.json # packages/internal-lib-build/package-lock.json # packages/pwa-kit-create-app/package-lock.json # packages/pwa-kit-dev/package-lock.json # packages/pwa-kit-dev/src/configs/webpack/config.js # packages/pwa-kit-dev/src/configs/webpack/plugins.js # packages/pwa-kit-react-sdk/package-lock.json # packages/pwa-kit-runtime/package-lock.json # packages/spike-extendend-retail-app/build/loadable-stats.json # packages/spike-extendend-retail-app/package-lock.json # packages/spike-extendend-retail-app/package.json # packages/template-retail-react-app/package-lock.json # packages/template-typescript-minimal/package-lock.json

…template extensibility, but `<path>/dir/non-index-name.(js|jsx|etc)` was not

…npm run push`

…m there

…/ project components

…educe conditional logic execution

This reverts commit 7f3c364.

vmarta · 2023-05-26T22:21:40Z

scripts/bump-version.js

+        // TODO: is it possible to _not_ trigger the lifecycle scripts? See CHANGELOG.md
+        setPackageVersion(oldVersion, {cwd: location})
+        setPackageVersion('prerelease', {cwd: location})


There's a bug currently with the changelog file in commerce-sdk-react. Because the package has its own version, it will run into this code block, which will cause more headings to be added in the changelog file.

I'm thinking let's fix this bug in another PR, since it's not a blocker and the changelog can be manually fixed by hand.

bfeister · 2023-05-26T23:06:46Z

Re-iterating the known PR check issue from #1205 (comment)

We are merging this without CI Windows passing. This is a known issue, but must be resolved for v3 to launch. A new GUS ticket is open here to track fixing this prior to an official / feature-complete v3 release:
W-13493426

alexvuong · 2023-05-29T17:29:23Z

scripts/pwa-kit-deps-version.js

@@ -0,0 +1,58 @@
+/*


Nit: Can we rename this file to bump-pwa-kit-deps-version? It is longer but give you a bit of a context what it does

alexvuong · 2023-05-29T17:29:57Z

scripts/independent-pkg-version.js

@@ -0,0 +1,47 @@
+#!/usr/bin/env node


Nit: Can we rename this file as bump-independent-pkg-version.js?

Alternatively, we can put these three scripts for version bumping into a separate folder

adamraya · 2023-05-29T20:28:32Z

packages/pwa-kit-create-app/scripts/run-local-npm.js

@@ -0,0 +1,79 @@
+#!/usr/bin/env node


This script is no longer in use. Should we remove it?

packages/pwa-kit-create-app/scripts/run-local-npm.js

* develop: Versioning the retail react app (#1209) [V3] Add `templateVersion` arg to `create-react-app` (#1229) [Extensibility 🤌🏻] Make `create-app` work with "extended templates" (#1205)

bfeister and others added 30 commits March 13, 2023 19:06

more fixes for out of sync package / lockfiles

e2bb649

add missing pwa-kit packages

f4790fc

Fix regex matching patterns (#1057)

e18076c

* resolve package lock errors * clean console logs and code * more cleanup, remove duplicate items in overrideregex * upgrade minimatch version, match all file extensions, match with no file extension

fix dependency dupes

694104e

Remove all console logs / cleanup / unnecessary code

7664191

fix some problems with final cleanup

2e1ec7f

merge

80e29f9

remove stress test files post-merge

a456791

added pdp page override with small customization

de04c3e

add constants file to spike project and tweak overrides values

d1ca004

Fix bug where <path>/dir/index.(js|jsx|etc) was being picked up by …

c843b5c

…template extensibility, but `<path>/dir/non-index-name.(js|jsx|etc)` was not

fix package.json scripts

f675074

fix falsy value defaulting causing errors in path.join fix broken `…

478276d

…npm run push`

delete build/loadable-stat.json from git, gitignore should work fro…

89795cc

…m there

fix some file pathing issues in how SDK looks up default / universal …

d7f8861

…/ project components

Perf enhancements, don't use regex all (.*) for module replacement, r…

71c037c

…educe conditional logic execution

minor code style tweak

c7e9be5

cleanup

1306b57

initial work on moving code to use resolver

3f8939e

fix getoverridepath and break on ^ imports

f650221

add todos and comments

a5d3f01

rewrite requestcontext.request for path with caret

2eecb75

perform overrideshashmap lookup for relative import

3766818

merge v3 and regenerate lock files with version 2

24bb5c3

progress

1b42d87

fix conflicts

6fd8cdd

fix package lockfiles that were out of sync

7f3c364

Revert "fix package lockfiles that were out of sync"

f0900d5

This reverts commit 7f3c364.

progress

9a2252c

vmarta added 2 commits May 25, 2023 22:54

Reconsider where to do npm install

315be52

Clean up

e1059c2

vmarta changed the base branch from feature/template-extensibility to develop May 26, 2023 16:02

vmarta changed the base branch from develop to feature/template-extensibility May 26, 2023 16:08

vmarta added 3 commits May 26, 2023 13:59

Remove todo

8053cfa

Merge branch 'develop' into versioning-retail-react-app

1612d55

Remove unused dependency

95a5cba

vmarta changed the base branch from feature/template-extensibility to develop May 26, 2023 21:08

Some code cleanup

3210576

vmarta commented May 26, 2023

View reviewed changes

Merge branch 'develop' into versioning-retail-react-app

bb3fc73

bfeister self-requested a review May 26, 2023 23:04

bfeister previously approved these changes May 26, 2023

View reviewed changes

alexvuong reviewed May 29, 2023

View reviewed changes

alexvuong previously approved these changes May 29, 2023

View reviewed changes

Move the versioning scripts into their own folder

7f66aec

vmarta dismissed stale reviews from alexvuong and bfeister via 7f66aec May 29, 2023 19:09

Merge branch 'develop' into versioning-retail-react-app

0fcf9f3

alexvuong previously approved these changes May 29, 2023

View reviewed changes

adamraya reviewed May 29, 2023

View reviewed changes

kevinxh reviewed May 29, 2023

View reviewed changes

packages/pwa-kit-create-app/scripts/run-local-npm.js Outdated Show resolved Hide resolved

Delete run-local-npm.js

6ea4a4a

vmarta dismissed alexvuong’s stale review via 6ea4a4a May 29, 2023 22:54

adamraya approved these changes May 29, 2023

View reviewed changes

alexvuong approved these changes May 29, 2023

View reviewed changes

bendvc merged commit 2983781 into develop May 29, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Versioning the retail react app #1209

Versioning the retail react app #1209

vmarta commented May 16, 2023 •

edited

Loading

vmarta May 26, 2023

bfeister commented May 26, 2023

alexvuong May 29, 2023

alexvuong May 29, 2023

alexvuong May 29, 2023

adamraya May 29, 2023

Versioning the retail react app #1209

Versioning the retail react app #1209

Conversation

vmarta commented May 16, 2023 • edited Loading

How to Test-Drive This PR

Releasing SDK v3.0.0

Releasing commerce-sdk-react v1.0.0

Releasing retail-react-app v1.0.0

Checklists

General

Accessibility Compliance

Localization

vmarta May 26, 2023

Choose a reason for hiding this comment

bfeister commented May 26, 2023

alexvuong May 29, 2023

Choose a reason for hiding this comment

alexvuong May 29, 2023

Choose a reason for hiding this comment

alexvuong May 29, 2023

Choose a reason for hiding this comment

adamraya May 29, 2023

Choose a reason for hiding this comment

vmarta commented May 16, 2023 •

edited

Loading